Skip to content

feat: update validate_ibm_catalog_json pre-commit hook to check for HCL editor #1257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Dec 1, 2025
Merged

feat: update validate_ibm_catalog_json pre-commit hook to check for HCL editor #1257

merged 5 commits into from
Dec 1, 2025

Conversation

@akocbek
Copy link
Contributor

@akocbek akocbek commented Oct 15, 2025 •
edited
Loading

Description

Input is not inside ibm_catalog.json

image

input is inside ibm_catalog.json but not HCL editor is used
image

input is inside ibm_catalog.json and HCL editor is used
image

Release required?

  • No release
  • Patch release (x.x.X)
  • Minor release (x.X.x)
  • Major release (X.x.x)
Release notes content

Run the pipeline

If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.

Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:

/run pipeline

Checklist for reviewers

  • If relevant, a test for the change is included or updated with this PR.
  • If relevant, documentation for the change is included or updated with this PR.

For mergers

  • Use a conventional commit message to set the release level. Follow the guidelines.
  • Include information that users need to know about the PR in the commit message. The commit message becomes part of the GitHub release notes.
  • Use the Squash and merge option.

@akocbek akocbek requested a review from ocofaigh as a code owner October 15, 2025 12:41
@ocofaigh
Copy link
Contributor

ocofaigh commented Oct 24, 2025

@akocbek FYI the catalog team are adding support to only allow HCL in this editor. I think we should hold off merging this until that is supported

@ocofaigh
Copy link
Contributor

ocofaigh commented Nov 6, 2025

@akocbek The new feature is in prod now. The syntax would look like this:

"custom_config": {
  "type": "code_editor",
  "grouping": "deployment",
  "original_grouping": "deployment",
  "config_constraints": {
    "supportedLanguages": [
      "hcl"
    ]
  }

@akocbek
Copy link
Contributor Author

akocbek commented Dec 1, 2025

Updated the error. The HCL editor syntax is also displayed.

image

ocofaigh
ocofaigh requested changes Dec 1, 2025
View reviewed changes
Copy link
Contributor

@ocofaigh ocofaigh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@akocbek Looks good - just 1 small comment

module-assets/ci/validateIbmCatalogJson.py Outdated
def check_hcl_editor(da_inputs, catalog_inputs):
inputs_not_have_hcl_editor = []
for da_input in da_inputs:
if da_input["type"].startswith("list(object") or da_input["type"].startswith(
Copy link
Contributor

@ocofaigh ocofaigh Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we also enforce for type "any"

Copy link
Contributor Author

@akocbek akocbek Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

ocofaigh
ocofaigh reviewed Dec 1, 2025
View reviewed changes
ocofaigh
ocofaigh reviewed Dec 1, 2025
View reviewed changes
@ocofaigh ocofaigh merged commit e976806 into main Dec 1, 2025
1 check passed
@ocofaigh ocofaigh deleted the hcl_editor branch December 1, 2025 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ocofaigh ocofaigh ocofaigh approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@akocbek @ocofaigh